[]
Ƭ CommandOption: Object
仪表板命令选项
name: CommandName
指定命令的名称
payload: SwitchTabCommandPayload
| SwitchPageCommandPayload
| DrillDownCommandPayload
| DrillUpCommandPayload
| DrillResetCommandPayload
| ToggleScenarioCommandPayload
| ShowScenarioCommandPayload
| HideScenarioCommandPayload
指定命令的有效负载
Ƭ DashboardDesignerDefaults: Object
用于初始化仪表板设计器的默认选项
名称 | 类型 |
---|---|
clickAction? |
string |
containerFilterScope? |
string |
contextMenuActions? |
string |
dashboardId? |
string |
datasetId? |
string |
documentThemeId? |
string |
dp? |
object | string |
enableDeveloperMode? |
boolean |
lng? |
string |
notificationTime? |
number |
templateId? |
string |
theme? |
string |
clickAction?: string
指定仪表板设计器的鼠标左键选项
containerFilterScope?: string
指定仪表板设计器的容器组件内部切片器的过滤范围
contextMenuActions?: string
指定仪表板设计器的鼠标右键选项
dashboardId?: string
指定仪表板设计器默认打开的文档
datasetId?: string
指定仪表板设计器默认使用的数据集
documentThemeId?: string
指定仪表板设计器默认使用的文档主题
dp?: object
| string
指定仪表板设计器默认的参数值
enableDeveloperMode?: boolean
启用或关闭仪表板设计器的开发人员模式。开启开发人员模式后可以使用可视化组件开发工具
lng?: string
指定仪表板设计器的默认语言
notificationTime?: number
指定仪表板设计器通知栏的默认停留时长
templateId?: string
指定仪表板设计器
theme?: string
指定仪表板设计器的默认主题
Ƭ DashboardDesignerFeatures: Object
用于打开或关闭仪表板设计器特性的功能选项
名称 | 类型 |
---|---|
actionbarItems? |
string [] |
componentCategories? |
string [] |
disableAnimation? |
boolean |
disableChangeDataset? |
boolean |
showCloseButton? |
boolean |
showDataBindingPanel? |
boolean |
showHelpButton? |
boolean |
showInspector? |
boolean |
showInspectorWhenOpen? |
boolean |
showMobileDesigner? |
boolean |
showPanelWhenOpen? |
boolean |
showWizard? |
boolean |
toolbar? |
"show" | "hide" |
actionbarItems?: string
[]
指定仪表板设计器的可用菜单项
componentCategories?: string
[]
指定仪表板设计器的可用组件类别
disableAnimation?: boolean
是否禁用仪表板设计器动画
disableChangeDataset?: boolean
是否禁用仪表板设计器修改默认数据集
showCloseButton?: boolean
是否显示关闭按钮
showDataBindingPanel?: boolean
是否显示数据绑定面板
showHelpButton?: boolean
是否显示帮助按钮
showInspector?: boolean
是否显示属性面板
showInspectorWhenOpen?: boolean
是否在打开仪表板设计器时显示属性面板
showMobileDesigner?: boolean
是否显示移动端设计器按钮
showPanelWhenOpen?: boolean
是否在打开仪表板设计器时显示组件工具箱面板
showWizard?: boolean
是否在打开仪表板设计器时显示智能组件添加向导
toolbar?: "show"
| "hide"
是否显示工具栏
Ƭ DashboardDesignerInitOption: Object
仪表板设计器初始化选项
名称 | 类型 |
---|---|
container |
Element |
defaults? |
DashboardDesignerDefaults |
features? |
DashboardDesignerFeatures |
onClose? |
() => void |
onError? |
(errorInfo : object ) => void |
onLoaded? |
(docName : string ) => void |
onMount? |
() => void |
onSave? |
(docName : string , id : string ) => void |
container: Element
指定挂载仪表板设计器实例的DOM元素
defaults?: DashboardDesignerDefaults
用于初始化仪表板设计器的默认选项
features?: DashboardDesignerFeatures
用于打开或关闭仪表板设计器特性的功能选项
onClose?: () => void
注册一个回调函数,在仪表板设计器关闭时调用
onError?: (errorInfo
: object
) => void
注册一个回调函数,在捕获到仪表板设计器的错误时调用
onLoaded?: (docName
: string
) => void
注册一个回调函数,在仪表板设计器加载完成后调用
onMount?: () => void
注册一个回调函数,在仪表板设计器挂载完成后调用
onSave?: (docName
: string
, id
: string
) => void
注册一个回调函数,在仪表板设计器保存时调用
Ƭ DashboardLiteViewerDefaults: Object
用于初始化仪表板标准查看器的默认选项
名称 | 类型 |
---|---|
clickAction? |
string |
containerFilterScope? |
string |
contextMenuActions? |
string |
dashboardId |
string |
documentThemeId? |
string |
dp? |
object | string |
hideErrors? |
boolean |
lng? |
string |
notificationTime? |
number |
pageNumber? |
string |
scenario? |
string |
showScenarioTitle? |
boolean |
theme? |
string |
clickAction?: string
指定仪表板标准查看器的鼠标左键选项
containerFilterScope?: string
指定仪表板标准查看器的容器组件内部切片器的过滤范围
contextMenuActions?: string
指定仪表板标准查看器的鼠标右键选项
dashboardId: string
指定仪表板标准查看器打开的文档
documentThemeId?: string
指定仪表板标准查看器默认使用的文档主题
dp?: object
| string
指定仪表板标准查看器默认的参数值
hideErrors?: boolean
是否隐藏仪表板标准查看器的错误通知
lng?: string
指定仪表板标准查看器的语言
notificationTime?: number
指定仪表板标准查看器通知栏的默认停留时长
pageNumber?: string
指定仪表版标准查看器的默认打开页码
scenario?: string
用于在单个可视化组件集成时指定组件的名称
showScenarioTitle?: boolean
用于在单个可视化组件集成时指定是否显示组件的标题
theme?: string
指定仪表板标准查看器的默认主题
Ƭ DashboardLiteViewerFeatures: Object
用于打开或关闭仪表板标准查看器特性的功能选项
名称 | 类型 |
---|---|
actionbarItems? |
string [] |
disableAnimation? |
boolean |
disableAutoScroll? |
boolean |
disableAutoSwitchPage? |
boolean |
actionbarItems?: string
[]
指定仪表板标准查看器的可用菜单项
disableAnimation?: boolean
是否禁用仪表板标准查看器动画
disableAutoScroll?: boolean
是否禁用仪表板标准查看器中组件的自动滚动功能
disableAutoSwitchPage?: boolean
是否禁用仪表板标准查看器的页面自动切换功能
Ƭ DashboardLiteViewerInitOption: Object
仪表板标准查看器初始化选项
名称 | 类型 |
---|---|
container |
Element |
defaults? |
DashboardViewerDefaults |
features? |
DashboardViewerFeatures |
container: Element
指定挂载仪表板标准查看器实例的DOM元素
defaults?: DashboardViewerDefaults
用于初始化仪表板标准查看器的默认选项
features?: DashboardViewerFeatures
用于打开或关闭仪表板标准查看器特性的功能选项
Ƭ DashboardViewerDefaults: Object
用于初始化仪表板高级查看器的默认选项
名称 | 类型 |
---|---|
clickAction? |
string |
containerFilterScope? |
string |
contextMenuActions? |
string |
dashboardId |
string |
documentThemeId? |
string |
dp? |
object | string |
hideErrors? |
boolean |
lng? |
string |
notificationTime? |
number |
pageNumber? |
string |
scenario? |
string |
showScenarioTitle? |
boolean |
size? |
"fitheight" | "fittoheight" | "fitwidth" | "fittowidth" | "fitscreen" | "fittoscreen" | "auto" |
theme? |
string |
clickAction?: string
指定仪表板高级查看器的鼠标左键选项
containerFilterScope?: string
指定仪表板高级查看器的容器组件内部切片器的过滤范围
contextMenuActions?: string
指定仪表板高级查看器的鼠标右键选项
dashboardId: string
指定仪表板高级查看器打开的文档
documentThemeId?: string
指定仪表板高级查看器默认使用的文档主题
dp?: object
| string
指定仪表板高级查看器默认的参数值
hideErrors?: boolean
是否隐藏仪表板高级查看器的错误通知
lng?: string
指定仪表板高级查看器的语言
notificationTime?: number
指定仪表板高级查看器通知栏的默认停留时长
pageNumber?: string
指定仪表版查看器的默认打开页码
scenario?: string
用于在单个可视化组件集成时指定组件的名称
showScenarioTitle?: boolean
用于在单个可视化组件集成时指定是否显示组件的标题
size?: "fitheight"
| "fittoheight"
| "fitwidth"
| "fittowidth"
| "fitscreen"
| "fittoscreen"
| "auto"
指定仪表板高级查看器的显示模式
theme?: string
指定仪表板高级查看器的默认主题
Ƭ DashboardViewerFeatures: Object
用于打开或关闭仪表板高级查看器特性的功能选项
名称 | 类型 |
---|---|
actionbarItems? |
string [] |
disableAnimation? |
boolean |
disableAutoScroll? |
boolean |
disableAutoSwitchPage? |
boolean |
hideToolbarActions? |
boolean |
actionbarItems?: string
[]
指定仪表板高级查看器的可用菜单项
disableAnimation?: boolean
是否禁用仪表板高级查看器动画
disableAutoScroll?: boolean
是否禁用仪表板高级查看器中组件的自动滚动功能
disableAutoSwitchPage?: boolean
是否禁用仪表板高级查看器的页面自动切换功能
hideToolbarActions?: boolean
指定仪表板高级查看器工具栏的隐藏菜单项
Ƭ DashboardViewerInitOption: Object
仪表板高级查看器初始化选项
名称 | 类型 |
---|---|
container |
Element |
defaults? |
DashboardViewerDefaults |
features? |
DashboardViewerFeatures |
onClose? |
() => void |
onError? |
(errorInfo : object ) => void |
onLoaded? |
(docName : string , id : string ) => void |
onMount? |
() => void |
onRendered? |
(docName : string ) => void |
container: Element
指定挂载仪表板高级查看器实例的DOM元素
defaults?: DashboardViewerDefaults
用于初始化仪表板高级查看器的默认选项
features?: DashboardViewerFeatures
用于打开或关闭仪表板高级查看器特性的功能选项
onClose?: () => void
注册一个回调函数,在仪表板高级查看器关闭时调用
onError?: (errorInfo
: object
) => void
注册一个回调函数,在捕获到仪表板高级查看器的错误时调用
onLoaded?: (docName
: string
, id
: string
) => void
注册一个回调函数,在仪表板高级查看器加载完成后调用
onMount?: () => void
注册一个回调函数,在仪表板高级查看器挂载完成后调用
onRendered?: (docName
: string
) => void
注册一个回调函数,在仪表板高级查看器渲染完成后调用
Ƭ DocumentSaveOption: Object
用于保存当前仪表板文档的选项
名称 | 类型 |
---|---|
categories? |
string [] |
comment? |
string |
name? |
string |
shouldPublish? |
boolean |
categories?: string
[]
指定文档的分类
comment?: string
指定文档的批注
name?: string
指定文档的名称
shouldPublish?: boolean
是否在服务器启用草稿功能时发布当前文档
Ƭ DocumentSyncOption: Object
用于切换仪表板设计器显示的选项
名称 | 类型 |
---|---|
syncChanges? |
boolean |
syncChanges?: boolean
是否将设计器预览时的状态更改同步到设计器中
Ƭ DrillDownCommandPayload: Object
执行Drilldown命令的有效负载。
名称 | 类型 |
---|---|
drillDimension? |
string |
target |
string |
drillDimension?: string
指定目标维度的名称。仅当钻取类型为All或List时才可用,即,如果钻取类型为Path,则会忽略DrillDimension并钻取到在数据绑定中指定的维度
target: string
指定目标可视化组件的名称
Ƭ DrillResetCommandPayload: Object
执行ResetDrill命令的有效负载。
名称 | 类型 |
---|---|
target |
string |
target: string
指定目标可视化组件的名称
Ƭ DrillUpCommandPayload: Object
执行DrillUp命令的有效负载。
名称 | 类型 |
---|---|
target |
string |
target: string
指定目标可视化组件的名称
Ƭ HideScenarioCommandPayload: Object
执行HideScenario命令的有效负载
名称 | 类型 |
---|---|
delay? |
number |
duration? |
number |
leaveAnimation? |
"none" | "top" | "bottom" | "left" | "right" | "fadeIn" |
scenarioId? |
string |
target |
string |
delay?: number
用于设置执行命令的延迟时间
duration?: number
用于设置隐藏可视化组件的持续时间
leaveAnimation?: "none"
| "top"
| "bottom"
| "left"
| "right"
| "fadeIn"
指定隐藏可视化组件的动画类型
scenarioId?: string
指定可视化组件ID
target: string
指定目标可视化组件的名称
Ƭ ShowScenarioCommandPayload: Object
执行ShowScenario命令的有效负载
名称 | 类型 |
---|---|
delay? |
number |
duration? |
number |
enterAnimation? |
"none" | "top" | "bottom" | "left" | "right" | "fadeIn" |
scenarioId? |
string |
target |
string |
delay?: number
用于设置执行命令的延迟时间
duration?: number
用于设置显示可视化组件的持续时间
enterAnimation?: "none"
| "top"
| "bottom"
| "left"
| "right"
| "fadeIn"
指定显示可视化组件的动画类型
scenarioId?: string
指定可视化组件ID
target: string
指定目标可视化组件的名称
Ƭ SwitchPageCommandPayload: Object
执行SwitchPage命令的有效负载。
名称 | 类型 |
---|---|
index? |
number |
name? |
string |
pageId? |
string |
index?: number
指定页面的索引
name?: string
指定页面的名称
pageId?: string
指定页面的ID
Ƭ SwitchTabCommandPayload: Object
执行SwitchTab命令的有效负载
名称 | 类型 |
---|---|
containerId? |
string |
index? |
number |
name? |
string |
target |
string |
containerId?: string
指定容器的ID
index?: number
指定容器的标签索引
name?: string
指定容器选项卡的名称
target: string
指定目标容器的名称
Ƭ ToggleScenarioCommandPayload: Object
执行ToggleScenario命令的有效负载
名称 | 类型 |
---|---|
delay? |
number |
duration? |
number |
enterAnimation? |
"none" | "top" | "bottom" | "left" | "right" | "fadeIn" |
leaveAnimation? |
"none" | "top" | "bottom" | "left" | "right" | "fadeIn" |
scenarioId? |
string |
target |
string |
delay?: number
用于设置执行命令的延迟时间
duration?: number
用于设置显示或隐藏可视化组件的持续时间
enterAnimation?: "none"
| "top"
| "bottom"
| "left"
| "right"
| "fadeIn"
指定显示可视化组件的动画类型
leaveAnimation?: "none"
| "top"
| "bottom"
| "left"
| "right"
| "fadeIn"
指定隐藏可视化组件的动画类型
scenarioId?: string
指定可视化组件ID
target: string
指定目标可视化组件的名称
Ƭ WynBIOption: Object
用于创建仪表板实例的基本选项
名称 | 类型 |
---|---|
baseUrl |
string |
token |
string |
baseUrl: string
指定Wyn服务器地址
token: string
指定访问令牌。访问令牌从系统管理控制台生成